GetTimeBaseStatus
Your application can retrieve status information from a time base by calling theGetTimeBaseStatus
function. This status information allows you to determine when the current time of a time base would fall outside of the range of values specified by the start and stop times of the time base. This can happen when a time base relies on a master time base or when its time has reached the stop time.
pascal long GetTimeBaseStatus (TimeBase tb, TimeRecord *unpinnedTime);
tb
- Specifies the time base for this operation. Your application obtains this time base identifier from the
NewTimeBase
function (described on page 2-297).unpinnedTime
- Contains a pointer to a time structure that is to receive the current time of the time base. Note that this time value may be outside the range of values specified by the start and stop times of the time base.
DESCRIPTION
TheGetTimeBaseStatus
function returns flags that indicate whether the returned time value is outside the range of values specified by the start and stop times of the time base. The following flags are defined (unused flags are set to 0):
timeBaseBeforeStartTime
- Indicates that the time value represented by the contents of the time structure referred to by the
unpinnedTime
parameter lies before the start time of the time base. The Movie Toolbox sets this flag to 1 if the current time is before the start time of the time base.timeBaseAfterStopTime
- Indicates that the time value represented by the contents of the time structure referred to by the
unpinnedTime
parameter lies after the stop time of the time base. The Movie Toolbox sets this flag to 1 if the current time is after the stop time of the time base.ERROR CODES
None